home *** CD-ROM | disk | FTP | other *** search
/ Teach Yourself VRML 2 in 21 Days / Teach Yourself VRML 2 in 21 Days.iso / mac / ISO9660 / 3rdparty / POLYTRAN / dos / PT_DOS.ZIP / DOC_1 / IMP_STRA.1 < prev    next >
Encoding:
Text File  |  1996-08-24  |  9.3 KB  |  240 lines
  1. .so psroff.inc        # Include the macros needed for output to Postscript
  2. .TH Import-StudioPro
  3. .SH NAME
  4. imp_stra \- Strata StudioPro geometry import filter
  5. .SH SYNOPSIS
  6. .PP
  7. This man page describes the options specific to the Strata StudioPro geometry
  8. import converter.
  9. .PP
  10. .SH EXAMPLE CONVERSION SYNTAX
  11. .PP
  12. To convert a Strata StudioPro file to Wavefront using the default 
  13. parameters listed in the setup.ini file:
  14. .IP
  15. pt -i sspro -o wave filename.vis
  16. .PP
  17. To convert a Strata StudioPro file to VRML and override some of the default 
  18. options in setup.ini:
  19. .IP
  20. pt -i sspro -in-sspro-debug = yes -o vrml filename.vis
  21. .PP
  22. .SH OVERVIEW
  23. .PP
  24. This geometry import converter reads files which are in the Strata StudioPro 
  25. file format. This converter is probably one of the most complete Strata 
  26. StudioPro file readers next to that of the one included with Strata StudioPro 
  27. itself. You will find that most StudioPro models are of quite high quality, 
  28. with good use of bezier patches (for high resolution modeling) and good use 
  29. of shading + texture mapping to give realistic rendered results. 
  30. .PP
  31. This converter reads in almost every aspect of a StudioPro file so that the 
  32. file can be rendered with little or no modifications by the NuGraf renderer, 
  33. or exported and rendered faithfully with an external renderer such as 
  34. Autodesk's 3D Studio. All in all this is one of the more complex import 
  35. converters. See the end of the this file which describes which entities are 
  36. handled by this converter.
  37. .PP
  38. .SH OVERVIEW
  39. .PP
  40. 1. If you are converting a Strata StudioPro file which was obtained from an 
  41. Apple Macintosh machine then you must manually add the '.vis' file extension 
  42. to these files.
  43. .PP
  44. 2. There is a good chance that this converter will not work on future files
  45. saved from Strata's StudioPro program. This is due to the fact that the 
  46. StudioPro file format does not allow unknown chunks to be skipped over. At
  47. such a time this converter will be updated with the file format information 
  48. must be officially obtained from Strata Corporation.
  49. .PP 
  50. 3. Strata StudioPro files are unusual because they embed the texture images 
  51. right inside the scene file itself (almost all other file formats do not do 
  52. this). This converter extracts these embedded images and stores them on disk 
  53. as TIFF files with the first few letters of the texture image filename coming 
  54. from that of the original StudioPro input filename. The TIFF files are
  55. stored in the directory controlled by the '-in-sspro-texture-dest-directory-type'
  56. option described below. 
  57. .PP
  58. 4. Please be wary of any StudioPro files which were not written out by the 
  59. Strata StudioPro program itself - many of such files are corrupt or written 
  60. in a non-standard method. For example, the StudioPro files on Viewpoint 
  61. Datalab's '5 Free for Siggraph 95' are some such examples - they have placed 
  62. each and every polygon within its own object definition rather than placing 
  63. all polygons within one object; in addition, many of these example models 
  64. have incorrect entity offsets that are completely illegal. This converter 
  65. tries to detect such bad files and will try to read the files if possible.
  66. .PP
  67. .SH COMMAND LINE OPTIONS
  68. .PP
  69. The following options are specific to this import converter:
  70. .TP
  71. -i sspro
  72. This is the optional command line option which specifies that the input data
  73. is in Strata StudioPro file format. If not specified then the 
  74. converter will try to guess the input file's format from its file extension
  75. and then from the contents of its file. Note that the valid file extension
  76. is .vis. 
  77. .TP
  78. -in-sspro-bezier-subdiv-type = [ low | medium | high | custom ]
  79. Many StudioPro models are created using Bezier patches rather than polygons. 
  80. Bezier patches are stored in the file using a mathematical description of a 
  81. smooth surface instead of a rough approximation by polygons.
  82. .IP
  83. During the export process (say, when exporting a StudioPro file format to 3D 
  84. Studio), these Bezier patches must be converted to polygons. The 
  85. '-in-sspro-bezier-subdiv-type' option specifies how finely to subdivide these 
  86. bezier patches when turning them into polygonalized surfaces. Higher numbers 
  87. created more polygons, and thus smoother surfaces, but at the expense of 
  88. larger exported files and longer rendering times.
  89. .IP
  90. The program defaults to 'low' (6x6 subdivisions). A good way of determining 
  91. if you need to increase this subdivision level is check to see if the exported
  92. file is being rendered properly in the destination renderer. In many cases 
  93. StudioPro bezier patches are highly curved which causes 'non-planar' polygons
  94. to appear in the exported file; these non-planar polygons are illegal in many 
  95. rendering programs. To solve this non-planar polygon problem, just increase 
  96. the number of subdivisions (so that the bezier patch surface is turned into 
  97. many more smaller polygons).
  98. .IP
  99. The following describe the different subdivision levels:
  100. .IP
  101. low = 6x6 = 36 polygons per Bezier patch.
  102. .IP
  103. medium = 20x20 = 400 polygons per Bezier patch.
  104. .IP
  105. high = 50x50 = 2500 polygons per Bezier patch.
  106. .IP
  107. custom     = User defined. The subdivision level is set with the 
  108. '-in-sspro-bezier-subdivisions' described below.
  109. .TP
  110. -in-sspro-bezier-subdivisions = <num_bezier_subdivisions>
  111. This is the number of subdivisions in the u and v directions for Bezier
  112. patches if the '-in-sspro-bezier-subdiv-type' option above is set to
  113. 'custom'. If you assign a number greater than 1 then the bezier patch will 
  114. be subdivided into the square of this number. For example, if you assign 4 
  115. then 16 polygons will be used. If you assign 10 then 100 polygons will be used.
  116. .TP
  117. -in-sspro-confirm-txtr-overwrites = [ yes | no ]
  118. Strata StudioPro files are unusual because they embed the texture images right 
  119. inside the scene file itself (almost all other file formats do not do this). This 
  120. converter extracts these embedded images and stores them on disk as TIFF 
  121. files in the directory controlled by the '-in-sspro-texture-dest-directory-type'
  122. option described below. 
  123. .IP
  124. If this option is set to 'yes' then the program will first confirm whether a texture 
  125. file (which is being extracted from the StudioPro file and saved to disk) should be 
  126. overwritten. If the user does not want the file, which already exists on disk, to be 
  127. overwritten then the converter will skip it. If this checkbox is not enabled then any 
  128. potential file overwrites will not be confirmed.
  129. .TP
  130. -in-sspro-texture-dest-directory-type = [ use-input-file-directory | use-execution-directory | use-specific-directory ]
  131. Strata StudioPro files are unusual because they embed the texture images right 
  132. inside the scene file itself. This converter extracts these embedded images 
  133. and stores them on disk as TIFF files in the directory controlled by this
  134. '-in-sspro-texture-dest-directory-type' option. 
  135. .IP
  136. The 'use-input-file-directory' option saves out the TIFF images to the same
  137. directory where the Strata StudioPro input file was read from.
  138. .IP
  139. The 'use-execution-directory' option saves out the TIFF images to the 
  140. directory where this translation program was executed from.
  141. .IP
  142. The 'use-specific-directory' option saves out the TIFF images to the directory 
  143. specified by the '-in-sspro-texture-dest-directory' option below.
  144. .TP
  145. -in-sspro-texture-dest-directory = "a valid directory path"
  146. This option lists a directory path where the Strata StudioPro embedded bitmap
  147. images will be saved to disk as TIFF images. This directory path only applies
  148. while the '-in-sspro-texture-dest-directory-type' option is set to 
  149. 'use-specific-directory'.
  150. .TP
  151. -in-sspro-output-debug-info = [ yes | no ]
  152. If this option is set to 'yes' then the contents of the Strata StudioPro file 
  153. will be verbosely described and output to the file 'debugstr.txt'.
  154. .TP
  155. -in-sspro-report-stats    = [ yes | no ]
  156. If this option is set to 'yes' then the converter will report the number of 
  157. objects, polygons, cameras, lights and materials created.
  158. .TP
  159. -in-sspro-read-cameras = [ yes | no ]
  160. .PD 0
  161. .TP
  162. -in-sspro-read-lights = [ yes | no ]
  163. .TP
  164. -in-sspro-read-geometry = [ yes | no ]
  165. .TP
  166. -in-sspro-read-materials = [ yes | no ]
  167. .PD
  168. These switches allow specific sections of the Strata StudioPro file to be excluded
  169. or included in the import process. All default to 'yes' which means that
  170. all named entities will be read in. If set to 'no' then the named section(s)
  171. will not be read into memory. 
  172. .PP
  173. .SH CURRENTLY SUPPORTED STUDIOPRO ENTITIES
  174. .PP
  175. .nf
  176. TCONE
  177. TCUBE
  178. TBEZIERMESH
  179. TBEZIERPATCH
  180. TDISC
  181. TENTITY
  182. TINSTANCE
  183. TGROUP
  184. TCAMERA
  185. TMODEL
  186. TMESH
  187. TDIRECTIONALLIGHT
  188. TPOSITIONALLIGHT
  189. TBULEMICMESH
  190. TSELECTIVEMESH
  191. TORDEREDBEZIERMESH
  192. TSPHERE
  193. TSPOTLIGHT
  194. TIMAGEMAP
  195. TRGBIMAGEMAP
  196. T2DRECT
  197. TATTRIBUTE
  198. T2DPOLYLINE
  199. T2DHOLE
  200. T2DPOLYGON
  201. TSHADER
  202. TMETALSHADER
  203. TPOLYLINE
  204. THOLE
  205. TPOLYGON
  206. TSURFACEMAP
  207. .fi
  208. .PP
  209. .SH CURRENTLY NON-SUPPORTED STUDIOPRO ENTITIES
  210. .PP
  211. .nf
  212. T3DPAINT
  213. TCUBEROUNDED
  214. TEXTERNALENTITY
  215. TSKINENTITY
  216. TSKINENTITYNEW
  217. TTRIANGLE
  218. TSMOOTHTRIANGLE
  219. TBLENDINGSHADER
  220. TEXTERNALSHADER
  221. TENVIRONMENT
  222. TSHADERENVIRONMENT
  223. TEXTERNALENVIRONMENT
  224. THORIZONENVIRONMENT
  225. TPICTUREENVIRONMENT
  226. TRGBENVIRONMENT
  227. TLAYER
  228. TLINKAGES
  229. T2DENTITY
  230. T2DBEZIERCURVE
  231. T2DBEZIERHOLE
  232. T2DBEZIERREGION
  233. TCLOSEDRIB
  234. TOPENRIB
  235. T2DGROUP
  236. T2DOVAL
  237. T2DROUNDRECT
  238. TQUICKDISPLAYLIST
  239. .fi
  240.